package com.example.demo03.entity.response;


import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;


/**
 * The TodoItemAPI class represents the data model of a TodoItem for API responses.
 * It contains essential information that is exposed to clients through API endpoints.
 * This class is designed to hold only the necessary information that needs to be sent
 * over the API, which includes the TodoItem's id, name, description, and score.
 *
 * @author [Your Name]
 * @version 1.0
 * @since [Date]
 * @ApiModel(description = "TodoItem data model for API responses")
 */
@Data
@ApiModel(description = "TodoItem data model for API responses")
public class TodoItemAPI {


    /**
     * The unique identifier of the TodoItem.
     *
     * @ApiModelProperty(notes = "The unique identifier of the TodoItem", example = "1", required = true, position = 1)
     */
    @ApiModelProperty(notes = "The unique identifier of the TodoItem", example = "1", required = true, position = 1)
    private Long id;


    /**
     * The name of the TodoItem.
     *
     * @ApiModelProperty(notes = "The name of the TodoItem", example = "Buy groceries", required = true, position = 2)
     */
    @ApiModelProperty(notes = "The name of the TodoItem", example = "Buy groceries", required = true, position = 2)
    private String name;


    /**
     * The description of the TodoItem.
     *
     * @ApiModelProperty(notes = "The description of the TodoItem", example = "Buy milk, bread, and eggs", position = 3)
     */
    @ApiModelProperty(notes = "The description of the TodoItem", example = "Buy milk, bread, and eggs", position = 3)
    private String description;


    /**
     * The priority score of the TodoItem.
     *
     * @ApiModelProperty(notes = "The priority score of the TodoItem", example = "5", position = 4)
     */
    @ApiModelProperty(notes = "The priority score of the TodoItem", example = "5", position = 4)
    private Integer score;
}